docs/development/Hardware Debugging.md

   1 # Hardware debugging
   2
   3 The code can be compiled with debugging information, you can then upload a debug version to a board via a JLink/St-Link debug adapter and step through the code in your IDE.
   4
   5 More information about the necessary hardware and setting up the eclipse IDE can be found [here](Hardware%20Debugging%20in%20Eclipse.md)
   6
   7 A guide for visual studio can be found here:
   8 http://visualgdb.com/tutorials/arm/st-link/
   9
  10 This video is also helpful in understanding the proces:
  11 https://www.youtube.com/watch?v=kjvqySyNw20
  12
  13 ## Hardware
  14
  15 Various debugging hardware solutions exist, the Segger J-Link clones are cheap and are known to work on Windows with both the Naze and Olimexino platforms.
  16
  17 ### J-Link devices
  18
  19 Segger make excellent debuggers and debug software.
  20
  21 The Segger J-Link GDB server can be obtained from here.
  22
  23 http://www.segger.com/jlink-software.html
  24
  25 #### Segger J-Link EDU EDU version, for hobbyists and educational use.
  26
  27 ![Segger J-Link EDU](assets/hardware/j-link-edu.jpg)
  28
  29 https://www.segger.com/j-link-edu.html
  30
  31 #### USB-MiniJTAG J-Link JTAG/SWD Debugger/Emulator
  32
  33 http://www.hotmcu.com/usbminijtag-jlink-jtagswd-debuggeremula%E2%80%8Btor-p-29.html?cPath=3_25&zenid=fdefvpnod186umrhsek225dc10
  34
  35 ![THAOYU USB-MiniJTAG](assets/hardware/THAOYU-USB-MiniJTAG.jpg)
  36
  37 ##### ARM-JTAG-20-10 adapter
  38
  39 https://www.olimex.com/Products/ARM/JTAG/ARM-JTAG-20-10/
  40 http://uk.farnell.com/jsp/search/productdetail.jsp?sku=2144328
  41
  42 ![OLIMEX ARM JTAG ADAPTER](assets/hardware/OLIMEX-ARM-JTAG-ADAPTER-2144328-40.jpg)
  43
  44 #### CJMCU-STM32 Singlechip Development Board Jlink Downloader Jlink ARM Programmer
  45
  46 ![CJMCU-STM32 Jlink ARM Programmer Front](assets/hardware/cjmcu-jlink-front.jpg)
  47
  48 ![CJMCU-STM32 Jlink ARM Programmer Back](assets/hardware/cjmcu-jlink-back.jpg)
  49
  50 http://www.goodluckbuy.com/cjmcu-stm32-singlechip-development-board-jlink-downloader-jlink-arm-programmer.html
  51
  52
  53 ### STLink V2 devices
  54
  55 STLink V2 devices can be used too, via OpenOCD.
  56
  57 #### CEPark STLink V2
  58
  59 ![CEPark STLink V2](assets/hardware/cepark-stlink-v2-front.jpg)
  60
  61 http://www.goodluckbuy.com/cepark-stlink-st-link-v2-emulator-programmer-stm8-stm32-downloader.html
  62
  63 ## Compilation options
  64
  65 use `DEBUG=GDB` make argument.
  66
  67 You may find that if you compile all the files with debug information on that the program is too big to fit on the target device.  If this happens you have some options:
  68
  69 * Compile all files without debug information (`make clean`, `make ...`), then re-save or `touch` the files you want to be able to step though and then run `make DEBUG=GDB`.  This will then re-compile the files you're interested in debugging with debugging symbols and you will get a smaller binary file which should then fit on the device.
  70 * You could use a development board such as an PORT103R, development boards often have more flash rom.
  71
  72 ## OSX
  73
  74 ### Install OpenOCD via Brew
  75
  76 ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  77
  78 brew install openocd
  79
  80 ### GDB debug server
  81
  82 #### J-Link
  83
  84 ##### Windows
  85
  86 Run the Launch the J-Link GDB Server program and configure using UI.
  87
  88 #### OpenOCD
  89
  90 ##### Windows
  91
  92 STM32F103 targets
  93
  94     "C:\Program Files (x86)\UTILS\openocd-0.8.0\bin-x64\openocd-x64-0.8.0.exe" -f interface/stlink-v2.cfg -f target/stm32f1x_stlink.cfg
  95
  96 STM32F30x targets
  97
  98     "C:\Program Files (x86)\UTILS\openocd-0.8.0\bin-x64\openocd-x64-0.8.0.exe" -f scripts\board\stm32f3discovery.cfg
  99
 100 ##### OSX/Linux
 101
 102 STM32F30x targets
 103
 104       openocd -f /usr/share/openocd/scripts/board/stm32vldiscovery.cfg
 105
 106